<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>bot.Bot</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/ircbot-in-python/">Ircbot in Python</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="bot-module.html">Module&nbsp;bot</a> ::
        Class&nbsp;Bot
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="bot.Bot-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Bot</h1><p class="nomargin-top"><span class="codelink"><a href="bot-pysrc.html#Bot">source&nbsp;code</a></span></p>
<p>Connects to an irc server, logins into a channel and calls the 
  stayConnected method.</p>
  <p>Makes the calls to irc.IRC_Class, meteo.Client and 
  insults.Insult_Manager internally.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">nickname</span>,
        <span class="summary-sig-arg">username</span>,
        <span class="summary-sig-arg">password</span>,
        <span class="summary-sig-arg">server</span>,
        <span class="summary-sig-arg">channel</span>,
        <span class="summary-sig-arg">port</span>=<span class="summary-sig-default">6667</span>)</span><br />
      Loads the needed modules,sets up a few global constants, makes the 
      login and calls the infinite loop.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="bot-pysrc.html#Bot.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="bot.Bot-class.html#isCmd" class="summary-sig-name">isCmd</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">msg</span>)</span><br />
      Checks if the message is a bot command.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="bot-pysrc.html#Bot.isCmd">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="bot.Bot-class.html#isMathExpression" class="summary-sig-name">isMathExpression</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Checks if the message is a math expression.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="bot-pysrc.html#Bot.isMathExpression">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="bot.Bot-class.html#stayConnected" class="summary-sig-name">stayConnected</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">channel</span>)</span><br />
      Main loop.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="bot-pysrc.html#Bot.stayConnected">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="bot.Bot-class.html#calc" class="summary-sig-name">calc</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Checks if the message is a Math expression and passes it to the 
      python interpreter.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="bot-pysrc.html#Bot.calc">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="bot.Bot-class.html#perms" class="summary-sig-name">perms</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Sends to the channel the nicknames of the people who have full 
      permissions to use the bot.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="bot-pysrc.html#Bot.perms">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="bot.Bot-class.html#imitar" class="summary-sig-name">imitar</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Sets the nickname of the user it should imitate.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="bot-pysrc.html#Bot.imitar">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="bot.Bot-class.html#help" class="summary-sig-name">help</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Sends the bot's help to the channel.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="bot-pysrc.html#Bot.help">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="bot.Bot-class.html#list" class="summary-sig-name">list</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Sends the bot's help as a privmsg to the user.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="bot-pysrc.html#Bot.list">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="easter_egg1"></a><span class="summary-sig-name">easter_egg1</span>(<span class="summary-sig-arg">self</span>)</span><br />
      Returns madness.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="bot-pysrc.html#Bot.easter_egg1">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="easter_egg2"></a><span class="summary-sig-name">easter_egg2</span>(<span class="summary-sig-arg">self</span>)</span><br />
      Another easter egg created because of triton.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="bot-pysrc.html#Bot.easter_egg2">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="bot.Bot-class.html#copyCat" class="summary-sig-name">copyCat</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Sends to the channel the same message typed by the nickname the the 
      bot is currently imitating.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="bot-pysrc.html#Bot.copyCat">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="bot.Bot-class.html#copyCatAll" class="summary-sig-name">copyCatAll</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Sends to the channel the messages typed by all users in that channel.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="bot-pysrc.html#Bot.copyCatAll">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="bot.Bot-class.html#insult" class="summary-sig-name">insult</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Sends to the channel a random insult from the insults module.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="bot-pysrc.html#Bot.insult">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="bot.Bot-class.html#meteo" class="summary-sig-name">meteo</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Sends to the channel the temperature and weather conditions of a city
      if it exists in the meteo module database.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="bot-pysrc.html#Bot.meteo">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="bot.Bot-class.html#link" class="summary-sig-name">link</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Sends to the channel a url with the link to the website of this 
      project.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="bot-pysrc.html#Bot.link">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="bot.Bot-class.html#article" class="summary-sig-name">article</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Searches the Portugal-a-Programar magazine database for a word and 
      sends to the channel the articles that contain that word.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="bot-pysrc.html#Bot.article">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="bot.Bot-class.html#mag_update" class="summary-sig-name">mag_update</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Updates the magazine local cache.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="bot-pysrc.html#Bot.mag_update">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="bot.Bot-class.html#google" class="summary-sig-name">google</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Makes a search in google and prints it to the channel.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="bot-pysrc.html#Bot.google">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="bot.Bot-class.html#_reloadPerms" class="summary-sig-name" onclick="show_private();">_reloadPerms</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Reads the permissions file and creates a list of nicks that can fully
      use the bot.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="bot-pysrc.html#Bot._reloadPerms">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="bot.Bot-class.html#addPerms" class="summary-sig-name">addPerms</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Adds a nick to the permit ions file.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="bot-pysrc.html#Bot.addPerms">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="bot.Bot-class.html#rmPerms" class="summary-sig-name">rmPerms</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Removes a nick from the permissions file.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="bot-pysrc.html#Bot.rmPerms">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="isCmd"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">isCmd</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">msg</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="bot-pysrc.html#Bot.isCmd">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Checks if the message is a bot command.</p>
  <p>Returns True if it is, otherwise returns False.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="isMathExpression"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">isMathExpression</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="bot-pysrc.html#Bot.isMathExpression">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Checks if the message is a math expression.</p>
  <p>Returns True if it is, otherwise returns False.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="stayConnected"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">stayConnected</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">channel</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="bot-pysrc.html#Bot.stayConnected">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Main loop.</p>
  <p>Deals with the internal calls to the various methods defined in this 
  class. Also deals with the ping command sent by the server.</p>
  <p>Doesn't return anything, because it runs indefinitely.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="calc"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">calc</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="bot-pysrc.html#Bot.calc">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Checks if the message is a Math expression and passes it to the python
  interpreter.</p>
  <p>Doesn't return anything.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="perms"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">perms</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="bot-pysrc.html#Bot.perms">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sends to the channel the nicknames of the people who have full 
  permissions to use the bot.</p>
  <p>Doesn't return anything.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="imitar"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">imitar</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="bot-pysrc.html#Bot.imitar">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the nickname of the user it should imitate.</p>
  <p>It is also possible to imitate all users with the command $imitar all.
  THINK TWICE BEFORE YOU USE THIS.</p>
  <p>To stop the imitation, type the $imitar stop.</p>
  <p>Doesn't return anything.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="help"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">help</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="bot-pysrc.html#Bot.help">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sends the bot's help to the channel.</p>
  <p>Doesn't return anything.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="list"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">list</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="bot-pysrc.html#Bot.list">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sends the bot's help as a privmsg to the user.</p>
  <p>Doesn't return anything.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="copyCat"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">copyCat</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="bot-pysrc.html#Bot.copyCat">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sends to the channel the same message typed by the nickname the the 
  bot is currently imitating.</p>
  <p>Doesn't return anything.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="copyCatAll"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">copyCatAll</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="bot-pysrc.html#Bot.copyCatAll">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sends to the channel the messages typed by all users in that 
  channel.</p>
  <p>USE WISELY!</p>
  <p>Doesn't return anything.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="insult"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">insult</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="bot-pysrc.html#Bot.insult">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sends to the channel a random insult from the insults module.</p>
  <p>Doesn't return anything.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="meteo"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">meteo</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="bot-pysrc.html#Bot.meteo">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sends to the channel the temperature and weather conditions of a city 
  if it exists in the meteo module database.</p>
  <p>Doesn't return anything.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="link"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">link</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="bot-pysrc.html#Bot.link">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sends to the channel a url with the link to the website of this 
  project.</p>
  <p>Doesn't return anything.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="article"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">article</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="bot-pysrc.html#Bot.article">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Searches the Portugal-a-Programar magazine database for a word and 
  sends to the channel the articles that contain that word.</p>
  <p>Doesn't return anything.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="mag_update"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">mag_update</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="bot-pysrc.html#Bot.mag_update">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Updates the magazine local cache.</p>
  <p>Doesn't return anything.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="google"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">google</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="bot-pysrc.html#Bot.google">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Makes a search in google and prints it to the channel.</p>
  <p>Doesn't return anything.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="_reloadPerms"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_reloadPerms</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="bot-pysrc.html#Bot._reloadPerms">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Reads the permissions file and creates a list of nicks that can fully 
  use the bot.</p>
  <p>Doesn't return anything.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="addPerms"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">addPerms</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="bot-pysrc.html#Bot.addPerms">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Adds a nick to the permit ions file.</p>
  <p>Doesn't return anything.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="rmPerms"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">rmPerms</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="bot-pysrc.html#Bot.rmPerms">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Removes a nick from the permissions file.</p>
  <p>Doesn't return anything.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://code.google.com/p/ircbot-in-python/">Ircbot in Python</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Aug 29 12:22:20 2008
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
